package com.google.code.solrdimension.indexmodifiers;

import org.apache.solr.common.SolrInputDocument;

import com.google.code.solrdimension.config.DimensionConfigWrapper;
import com.google.code.solrdimension.config.dimension.DimensionConfig;
import com.google.code.solrdimension.config.dimensionvalue.AbstractDimensionValueConfig;

/**
 * Modifies the {@link SolrInputDocument} according to the configurations in {@link DimensionConfig}
 * 
 * @author mhc
 *
 */
public interface IndexModService {
    
    /**
     * Modify the index with the given {@link AbstractDimensionValueConfig}
     * @param config
     *      An instance of type {@link AbstractDimensionValueConfig}
     * @param inputDoc
     *      {@link SolrInputDocument}
     * @param objectToIndex
     *      The object to index
     * @param field
     *      The field to be added to the solr input document
     * @return
     *      True if this is successful, false otherwise
     */
    public boolean modifyIndex(AbstractDimensionValueConfig config, SolrInputDocument inputDoc, Object objectToIndex, String field);
    
    /**
     * Returns an appropiate instance of type IndexModAction for the DimensionValueConfig
     * @param dimensionValueConfig
     * @return
     */
    public IndexModAction getIndexModAction(AbstractDimensionValueConfig dimensionValueConfig);

}
